 | IBM Endpoint Manager Inspectors Reference (CURRENTLY BEING UPDATED) |
| IBM Endpoint Manager Inspectors Reference (CURRENTLY BEING UPDATED) |
Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile
The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.
These are the keywords available for querying various aspects of the system, including the name and version of the operating sytem. This chapter also covers the keywords used to describe the vendors and types of the various processors that coexist in a typical computer system. Some of these Inspectors are system-specific, but are included to provide cross-platform compatibility.
service pack with multiplicityCreation Methods| Declaration | Description | Platforms (?) |
| unique value of <service pack> | Returns a list of all unique service packs along with their respective counts. | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| multiplicity of <service pack with multiplicity> | <integer> | Returns an the number of times a service pack occurs. | AIX:8.2 |
service packCreation Methods| Declaration | Description | Platforms (?) |
| maximum of <service pack> | Returns the latest service pack. | AIX:8.2 |
| minimum of <service pack> | Returns the earliest service pack. | AIX:8.2 |
| current service pack of <operating system> | Returns the current service pack, or no such object if none have been applied at the current technology level. | AIX:8.2 |
| service pack <string> of <operating system> | Returns the service pack that matches the string in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'. | AIX:8.2 |
| service pack of <operating system> | Returns all service packs | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <service pack> as string | <string> | Returns a string that uniquely identifies a service pack in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'. | AIX:8.2 |
| abstract of <service pack> | <string> | Returns a string in the format "AIX base-tl-sp (Concluding) Service Pack", with 'Concluding' onyl for a CSP. | AIX:8.2 |
| extrema of <service pack> | <( service pack, service pack )> | Returns a tuple with the oldest and newest service packs. | AIX:8.2 |
| fileset version requirement <string> of <service pack> | <fileset version requirement> | Returns the fileset version requirements for the service pack if a fileset with an LPP name matching the string is a requirement of the service pack. | AIX:8.2 |
| fileset version requirement of <service pack> | <fileset version requirement> | Returns all of the fileset version requirements for the service pack. | AIX:8.2 |
| installed satisfied fileset version requirement of <service pack> | <fileset version requirement> | Returns all the fileset version requirements for the service pack that are installed and meet the version requirement. | AIX:8.2 |
| installed unsatisfied fileset version requirement of <service pack> | <fileset version requirement> | Returns all the fileset version requirements for the service pack that are installed but do not meet the version requirement. | AIX:8.2 |
| maximum of <service pack> | <service pack> | Returns the latest service pack. | AIX:8.2 |
| minimum of <service pack> | <service pack> | Returns the earliest service pack. | AIX:8.2 |
| name of <service pack> | <string> | Returns a string that uniquely identifies a service pack in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'. | AIX:8.2 |
| technology level of <service pack> | <technology level> | Returns the technology associated of the service pack. | AIX:8.2 |
| uninstalled fileset version requirement of <service pack> | <fileset version requirement> | Returns all the fileset version requirements for the service pack that are not installed. | AIX:8.2 |
| unique value of <service pack> | <service pack with multiplicity> | Returns a list of all unique service packs along with their respective counts. | AIX:8.2 |
technology level with multiplicityCreation Methods| Declaration | Description | Platforms (?) |
| unique value of <technology level> | Returns a list of all unique technology levels along with their respective counts. | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| multiplicity of <technology level with multiplicity> | <integer> | Returns an the number of times a technology level occurs. | AIX:8.2 |
technology levelCreation Methods| Declaration | Description | Platforms (?) |
| technology level of <service pack> | Returns the technology associated of the service pack. | AIX:8.2 |
| maximum of <technology level> | Returns the highest technology level. | AIX:8.2 |
| minimum of <technology level> | Returns the lowest technology level. | AIX:8.2 |
| current technology level of <operating system> | Returns the current technology level. This also includes the base level information, similar to 'oslevel -r'. | AIX:8.2 |
| technology level <string> of <operating system> | Returns the technology level that matches the string in the format "base-tl". For example, AIX 5.3 at technology level 6 is "5300-06". | AIX:8.2 |
| technology level of <operating system> | Returns all technology levels. | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <technology level> as string | <string> | Returns a string that uniquely identifies a technolgoy level in the format "base-tl". For example, AIX 5.3 at technology level 6 would be "5300-06". | AIX:8.2 |
| abstract of <technology level> | <string> | Returns a string in the format "AIX base-tl Update". | AIX:8.2 |
| extrema of <technology level> | <( technology level, technology level )> | Returns a tuple with the lowest and highest technology levels. | AIX:8.2 |
| fileset version requirement <string> of <technology level> | <fileset version requirement> | AIX:8.2 | |
| fileset version requirement of <technology level> | <fileset version requirement> | Returns all the required filesets version requirements for the technology level. | AIX:8.2 |
| installed satisfied fileset version requirement of <technology level> | <fileset version requirement> | Returns all the fileset version requirements for the technology level that are installed and meet the version requirement. | AIX:8.2 |
| installed unsatisfied fileset version requirement of <technology level> | <fileset version requirement> | Returns all the fileset version requirements for the technology level that are installed but do not meet the version requirement. | AIX:8.2 |
| maximum of <technology level> | <technology level> | Returns the highest technology level. | AIX:8.2 |
| minimum of <technology level> | <technology level> | Returns the lowest technology level. | AIX:8.2 |
| name of <technology level> | <string> | Returns a string that uniquely identifies a technolgoy level in the format "base-tl". For example, AIX 5.3 at technology level 6 would be "5300-06". | AIX:8.2 |
| uninstalled fileset version requirement of <technology level> | <fileset version requirement> | Returns all the fileset version requirements for the technology level that are not installed. | AIX:8.2 |
| unique value of <technology level> | <technology level with multiplicity> | Returns a list of all unique technology levels along with their respective counts. | AIX:8.2 |
fileset version record with multiplicityCreation Methods| Declaration | Description | Platforms (?) |
| unique value of <fileset version record> | Returns a list of all unique fileset version records along with their respective counts. | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| multiplicity of <fileset version record with multiplicity> | <integer> | Returns an the number of times a fileset version record occurs. | AIX:8.2 |
fileset version recordCreation Methods| Declaration | Description | Platforms (?) |
| fileset version record <fileset version record> | A self cast, used only for simplifying relevance. | AIX:8.2 |
| fileset version record <string> | Returns a fileset version record specified by the string in the format "ver.rel.mod.fix". | AIX:8.2 |
| version record of <fileset> | Returns the version record corresponding to the specified fileset as a fileset version record. | AIX:8.2 |
| <fileset version record> as fileset version record | A self cast, used only for simplifying relevance. | AIX:8.2 |
| maximum of <fileset version record> | Returns the highest fileset version record from a collection for fileset version records. | AIX:8.2 |
| minimum of <fileset version record> | Returns the lowest fileset version record from a collection for fileset version records. | AIX:8.2 |
| version record of <fileset version requirement> | Returns the version of the fileset requirement. | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <fileset version record> as fileset version record | <fileset version record> | A self cast, used only for simplifying relevance. | AIX:8.2 |
| <fileset version record> as string | <string> | Returns a string containing the version of the fileset in the format "ver.rel.mod.fix". | AIX:8.2 |
| extrema of <fileset version record> | <( fileset version record, fileset version record )> | Returns a tuple with the lowest and highest fileset version records from a collection for fileset version records. | AIX:8.2 |
| fix_part of <fileset version record> | <integer> | Returns the fourth component from a fileset version in the format "ver.rel.mod.(fix)". | AIX:8.2 |
| maximum of <fileset version record> | <fileset version record> | Returns the highest fileset version record from a collection for fileset version records. | AIX:8.2 |
| minimum of <fileset version record> | <fileset version record> | Returns the lowest fileset version record from a collection for fileset version records. | AIX:8.2 |
| mod_part of <fileset version record> | <integer> | Returns the third component from a fileset version in the format "ver.rel.(mod).fix". | AIX:8.2 |
| rel_part of <fileset version record> | <integer> | Returns the second component from a fileset version in the format "ver.(rel).mod.fix". | AIX:8.2 |
| unique value of <fileset version record> | <fileset version record with multiplicity> | Returns a list of all unique fileset version records along with their respective counts. | AIX:8.2 |
| ver_part of <fileset version record> | <integer> | Returns the first component from a fileset version in the format "(ver).rel.mod.fix". | AIX:8.2 |
fileset version requirementCreation Methods| Declaration | Description | Platforms (?) |
| fileset version requirement <fileset version requirement> | A self cast, used only for simplifying relevance. | AIX:8.2 |
| fileset version requirement <string> | Returns a fileset version requirement specified by the string in the format "lpp_name ver.rel.mod.fix". | AIX:8.2 |
| fileset version requirement <string> of <service pack> | Returns the fileset version requirements for the service pack if a fileset with an LPP name matching the string is a requirement of the service pack. | AIX:8.2 |
| fileset version requirement of <service pack> | Returns all of the fileset version requirements for the service pack. | AIX:8.2 |
| installed satisfied fileset version requirement of <service pack> | Returns all the fileset version requirements for the service pack that are installed and meet the version requirement. | AIX:8.2 |
| installed unsatisfied fileset version requirement of <service pack> | Returns all the fileset version requirements for the service pack that are installed but do not meet the version requirement. | AIX:8.2 |
| uninstalled fileset version requirement of <service pack> | Returns all the fileset version requirements for the service pack that are not installed. | AIX:8.2 |
| fileset version requirement <string> of <technology level> | AIX:8.2 | |
| fileset version requirement of <technology level> | Returns all the required filesets version requirements for the technology level. | AIX:8.2 |
| installed satisfied fileset version requirement of <technology level> | Returns all the fileset version requirements for the technology level that are installed and meet the version requirement. | AIX:8.2 |
| installed unsatisfied fileset version requirement of <technology level> | Returns all the fileset version requirements for the technology level that are installed but do not meet the version requirement. | AIX:8.2 |
| uninstalled fileset version requirement of <technology level> | Returns all the fileset version requirements for the technology level that are not installed. | AIX:8.2 |
| <fileset version requirement> as fileset version requirement | A self cast, used only for simplifying relevance. | AIX:8.2 |
| fileset version requirement <string> of <apar> | Returns the fileset version requirement for the APAR if a fileset with the LPP name that matches the string is a requirement for the APAR. | AIX:8.2 |
| fileset version requirement of <apar> | Returns all the required filesets version requirements for the APAR. | AIX:8.2 |
| installed satisfied fileset version requirement of <apar> | Returns all the fileset version requirements for the APAR that are installed and meet the version requirement. | AIX:8.2 |
| installed unsatisfied fileset version requirement of <apar> | Returns all the fileset version requirements for the APAR that are installed but do not meet the version requirement. | AIX:8.2 |
| uninstalled fileset version requirement of <apar> | Returns all the fileset version requirements for the APAR that are not installed. | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <fileset version requirement> as fileset version requirement | <fileset version requirement> | A self cast, used only for simplifying relevance. | AIX:8.2 |
| <fileset version requirement> as string | <string> | Returns a string contain the LLP name and the version of a fileset separated by a space. | AIX:8.2 |
| latest installed fileset of <fileset version requirement> | <fileset> | Returns the filesets that are installed with the same LPP name, regardless of version. | AIX:8.2 |
| lpp_name of <fileset version requirement> | <string> | Returns a string with the LPP name of the fileset. | AIX:8.2 |
| satisfying fileset of <fileset version requirement> | <fileset> | Returns the filesets that are installed with the same LPP name and a greater or equal version. | AIX:8.2 |
| version record of <fileset version requirement> | <fileset version record> | Returns the version of the fileset requirement. | AIX:8.2 |
grub block listCreation Methods| Declaration | Description | Platforms (?) |
| block list of <grub file location> | List of blocks contained int the file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <grub block list> as string | <string> | String containing a specified block list in form "0+50,100+25,200+1." | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub bootable imageCreation Methods| Declaration | Description | Platforms (?) |
| bootable image of <grub config file> | Returns the bootable image of a grub config file | Ubu:9.0, Lin:9.0, Sol:9.0 |
| bootable image <integer> of <grub config file> | Bootable image at zero-based-indexed entry in grub config file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| bootable image <string> of <grub config file> | Bootable image at specified by the string containing an entry's title. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| module of <grub bootable image> | <grub module> Plural: modules | Returns the module of a grub bootable image | Ubu:9.0, Lin:9.0, Sol:9.0 |
| <grub bootable image> as string | <string> | String containg title of bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| chainloader of <grub bootable image> | <grub file location> | File pointed to by chainloader for a bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| initrd of <grub bootable image> | <grub file location> | File containing initial ram disk for bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| kernel of <grub bootable image> | <grub kernel> | Kernel to be used for the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| module <integer> of <grub bootable image> | <grub module> | Module (at zero-based index) to be loaded with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| modules of <grub bootable image> | <grub module> | List of all modules to be loaded with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| quiet of <grub bootable image> | <boolean> | True if bootable image has been designated as quiet, so as not to display verbose booting information. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| root of <grub bootable image> | <grub device> | Root device that is associated with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| rootnoverify of <grub bootable image> | <grub device> | Root device, designated as "no-verify," that is associated with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| savedefault of <grub bootable image> | <boolean> | True if bootable image has been designated as "savedefault." This causes the bootable image to become the default after it has been booted. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| title of <grub bootable image> | <string> | Title of bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub color pairCreation Methods| Declaration | Description | Platforms (?) |
| highlight of <grub color scheme> | Color pair used for highlighted text. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| normal of <grub color scheme> | Color pair used for normal text. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <grub color pair> as string | <string> | String displaying color pair in form "foreground-color/background-color | Lin:8.2, Sol:8.2, Ubu:8.2 |
| background of <grub color pair> | <grub color> | Name of background color of the color pair. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| foreground of <grub color pair> | <grub color> | Name of foreground color of the color pair. | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub color schemeCreation Methods| Declaration | Description | Platforms (?) |
| color scheme of <grub config file> | Two color pairs specifying normal and highlighted screen colors | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| highlight of <grub color scheme> | <grub color pair> | Color pair used for highlighted text. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| normal of <grub color scheme> | <grub color pair> | Color pair used for normal text. | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub colorCreation Methods| Declaration | Description | Platforms (?) |
| background of <grub color pair> | Name of background color of the color pair. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| foreground of <grub color pair> | Name of foreground color of the color pair. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <grub color> as string | <string> | String containing the name of one of the colors in a color pair. | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub config fileCreation Methods| Declaration | Description | Platforms (?) |
| grub config file | Returns the grub config file from the default location, either "/boot/grub/menu.lst" or "/boot/grub/grub.conf". | Lin:8.2, Sol:8.2, Ubu:8.2 |
| grub config file <string> | Returns the grub config file at the path specified by the string. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| bootable image of <grub config file> | <grub bootable image> Plural: bootable images | Returns the bootable image of a grub config file | Ubu:9.0, Lin:9.0, Sol:9.0 |
| fallback image of <grub config file> | <grub image choice> Plural: fallback images | Returns the fallback image choice of a grub config file | Ubu:9.0, Lin:9.0, Sol:9.0 |
| bootable image <integer> of <grub config file> | <grub bootable image> | Bootable image at zero-based-indexed entry in grub config file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| bootable image <string> of <grub config file> | <grub bootable image> | Bootable image at specified by the string containing an entry's title. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| bootable images of <grub config file> | <list of grub bootable image> | Provides list of all bootable images in the config file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| color scheme of <grub config file> | <grub color scheme> | Two color pairs specifying normal and highlighted screen colors | Lin:8.2, Sol:8.2, Ubu:8.2 |
| default image of <grub config file> | <grub image choice> | Zero-based ordinal index of the default entry to be booted. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| fallback image <integer> of <grub config file> | <grub image choice> | Zero-based ordinal index to an entry in the config file designated as a fallback to be booted in case previous choice fails. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| fallback images of <grub config file> | <grub image choice> | A list of zero-based ordinal indexes to an entries in the config file designated as a fallback images to be booted in case previous choices fail. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| gfxmenu of <grub config file> | <grub file location> | File containing graphical menu. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| hiddenmenu of <grub config file> | <boolean> | True if menu has been explicitly designated to be hidden. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| path of <grub config file> | <string> | Full path to grub config file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| splashimage of <grub config file> | <grub file location> | File containing the splash screen image to be displayed at boot time. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| timeout of <grub config file> | <integer> | How many seconds to wait for a user choice before booting the default image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub deviceCreation Methods| Declaration | Description | Platforms (?) |
| root of <grub bootable image> | Root device that is associated with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| rootnoverify of <grub bootable image> | Root device, designated as "no-verify," that is associated with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| device of <grub file location> | Name of device of the file location, e.g., (hd0,0)blo | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <grub device> as string | <string> | String containing name of a device, such as (hd0,0). | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub file locationCreation Methods| Declaration | Description | Platforms (?) |
| chainloader of <grub bootable image> | File pointed to by chainloader for a bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| initrd of <grub bootable image> | File containing initial ram disk for bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| gfxmenu of <grub config file> | File containing graphical menu. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| splashimage of <grub config file> | File containing the splash screen image to be displayed at boot time. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| location of <grub kernel> | Full path name of the kernel file | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <grub file location> as string | <string> | Full name of file consisting of device (if present) and path. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| block list of <grub file location> | <grub block list> | List of blocks contained int the file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| device of <grub file location> | <grub device> | Name of device of the file location, e.g., (hd0,0)blo | Lin:8.2, Sol:8.2, Ubu:8.2 |
| path of <grub file location> | <string> | Path name of file without device. | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub image choiceCreation Methods| Declaration | Description | Platforms (?) |
| fallback image of <grub config file> | Returns the fallback image choice of a grub config file | Ubu:9.0, Lin:9.0, Sol:9.0 |
| default image of <grub config file> | Zero-based ordinal index of the default entry to be booted. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| fallback image <integer> of <grub config file> | Zero-based ordinal index to an entry in the config file designated as a fallback to be booted in case previous choice fails. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| fallback images of <grub config file> | A list of zero-based ordinal indexes to an entries in the config file designated as a fallback images to be booted in case previous choices fail. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <grub image choice> as string | <string> | String representation of a zero-based index to an image within the grub config file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| index of <grub image choice> | <integer> | Zero-based index to an image within the grub config file. | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub kernelCreation Methods| Declaration | Description | Platforms (?) |
| kernel of <grub bootable image> | Kernel to be used for the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| boot argument <integer> of <grub kernel> | <string> | The numbered boot argument for the kernel, in parameter=value form, if applicable. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| boot argument of <grub kernel> | <string> | First boot argument for kernel, in parameter=value form, if applicable. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| location of <grub kernel> | <grub file location> | Full path name of the kernel file | Lin:8.2, Sol:8.2, Ubu:8.2 |
grub moduleCreation Methods| Declaration | Description | Platforms (?) |
| module of <grub bootable image> | Returns the module of a grub bootable image | Ubu:9.0, Lin:9.0, Sol:9.0 |
| module <integer> of <grub bootable image> | Module (at zero-based index) to be loaded with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
| modules of <grub bootable image> | List of all modules to be loaded with the bootable image. | Lin:8.2, Sol:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <grub module> as string | <string> | String representing the name of the module module | Lin:8.2, Sol:8.2, Ubu:8.2 |
| nounzip of <grub module> | <boolean> | True if module is to be loaded without unzipping it | Lin:8.2, Sol:8.2, Ubu:8.2 |
smf fmriCreation Methods| Declaration | Description | Platforms (?) |
| fmri of <smf instance> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of a service instance. The FMRI is used to identify a specific instance of a service for administrative use. | Sol:8.2 |
| fmri of <smf property group> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of a property group. The FMRI is used to identify a specific property group for administrative use. | Sol:8.2 |
| fmri of <smf property> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of an smf property. The FMRI is used to identify a specific instance for administrative use. | Sol:8.2 |
| fmri of <smf service> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of a service. The FMRI is used to identify a service for administrative use. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf fmri> as string | <string> | Returns a string representation of the smf fmri object. The string has the general form 'svc:<service name>:<service instance>'. For example 'svc:/network/login:rlogin', where 'svc' signifies an SMF service, '/network/login' is the service name, and 'rlogin' is the service instance. | Sol:8.2 |
smf instanceCreation Methods| Declaration | Description | Platforms (?) |
| parent instance of <smf property group> | Returns the specific service instance to which this property group belongs. | Sol:8.2 |
| instance <string> of <smf service> | Returns the specified instance of an smf service. An smf instance represents a particular piece of server software (such as 'Apache'). | Sol:8.2 |
| instance of <smf service> | Iterates over the instances of a service. An smf instance represents a particular piece of server software (such as 'Apache'). | Sol:8.2 |
| parent instance of <smf snapshot> | Returns the service instance to which this snapshot belongs. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf instance> as string | <string> | Returns a string representation of the smf instance object. This is the same as the end component of the FMRI ('Fault Management Resource Identifier') of the instance, and the same as the name of the instance. | Sol:8.2 |
| fmri of <smf instance> | <smf fmri> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of a service instance. The FMRI is used to identify a specific instance of a service for administrative use. | Sol:8.2 |
| name of <smf instance> | <string> | Returns the name of the smf instance object. This is the same as the end component of the FMRI ('Fault Management Resource Identifier') of the instance. | Sol:8.2 |
| parent service of <smf instance> | <smf service> | Returns the smf service to which this instance belongs. Each service can have multiple instances which can share configuration with each other as well as maintain individual configuration and characteristics. | Sol:8.2 |
| property group <string> of <smf instance> | <smf property group> | Returns the specified smf property group of a particular service instance. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| property group of <smf instance> | <smf property group> | Iterates over property groups of a service instance. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| snapshot <string> of <smf instance> | <smf snapshot> | Returns the specified smf snapshot of a service instance. A snapshot is an unchanging picture of the full set of property groups associated with an instance. Snapshots are automatically created and managed by the Service Management Facility. A snapshot consists of a set of snaplevels, each of which holds copies of the property groups associated with an instance or service in the resolution path of the base instance. Typically, there is one snaplevel for the instance and one for the instance's parent service. | Sol:8.2 |
| snapshot of <smf instance> | <smf snapshot> | Iterates over the snapshots of a service instance. A snapshot is an unchanging picture of the full set of property groups associated with an instance. Snapshots are automatically created and managed by the Service Management Facility. A snapshot consists of a set of snaplevels, each of which holds copies of the property groups associated with an instance or service in the resolution path of the base instance. Typically, there is one snaplevel for the instance and one for the instance's parent service. | Sol:8.2 |
smf property groupCreation Methods| Declaration | Description | Platforms (?) |
| property group <string> of <smf instance> | Returns the specified smf property group of a particular service instance. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| property group of <smf instance> | Iterates over property groups of a service instance. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| property group <string> of <smf service> | Returns the specified property group of a service. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| property group of <smf service> | Iterates over the property groups of a service. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| property group <string> of <smf snapshot part> | Returns the specified property group of a snapshot part. | Sol:8.2 |
| property group of <smf snapshot part> | Iterates over the property groups of a snapshot part. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf property group> as string | <string> | A string representation of an smf property group. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| fmri of <smf property group> | <smf fmri> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of a property group. The FMRI is used to identify a specific property group for administrative use. | Sol:8.2 |
| name of <smf property group> | <string> | Returns the name of a property group. An smf property group is a group of name/value pairs that represent configuration settings. | Sol:8.2 |
| nonpersistent flag of <smf property group> | <boolean> | Returns a boolean value indicating that the property group configuration will not be retained beyond a system shutdown or reboot. | Sol:8.2 |
| parent instance of <smf property group> | <smf instance> | Returns the specific service instance to which this property group belongs. | Sol:8.2 |
| parent service of <smf property group> | <smf service> | Returns the service to which this property group belongs. | Sol:8.2 |
| parent snapshot part of <smf property group> | <smf snapshot part> | Returns an object that represents a part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
| property <string> of <smf property group> | <smf property> | Returns the specified smf property object of the property group. Each smf property represents a setting as a name/value pair. | Sol:8.2 |
| property of <smf property group> | <smf property> | Iterates over the smf properties of a property group. Each smf property represents a setting as a name/value pair. | Sol:8.2 |
| type of <smf property group> | <string> | Returns a string representing the type of the property group. Each property group has a type corresponding to its purpose. The core property group types are method, dependency, application, and framework. Additional property group types can be introduced, provided they conform to the extended naming convention in smf(5). | Sol:8.2 |
smf propertyCreation Methods| Declaration | Description | Platforms (?) |
| property <string> of <smf property group> | Returns the specified smf property object of the property group. Each smf property represents a setting as a name/value pair. | Sol:8.2 |
| property of <smf property group> | Iterates over the smf properties of a property group. Each smf property represents a setting as a name/value pair. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf property> as string | <string> | Returns a string representation of an smf property object. Each smf property represents a setting as a name/value pair. This string representation is just the name portion of the property. | Sol:8.2 |
| fmri of <smf property> | <smf fmri> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of an smf property. The FMRI is used to identify a specific instance for administrative use. | Sol:8.2 |
| name of <smf property> | <string> | Returns the name of an smf property. Each smf property represents a setting as a name/value pair. | Sol:8.2 |
| type of <smf property> | <string> | Returns a string identifying the type of an smf property. These types can have values of SCF_TYPE_INVALID, SCF_TYPE_BOOLEAN, SCF_TYPE_COUNT, SCF_TYPE_INTEGER, SCF_TYPE_TIME, SCF_TYPE_ASTRING, SCF_TYPE_OPAQUE, SCF_TYPE_USTRING, SCF_TYPE_URI, SCF_TYPE_FMRI, SCF_TYPE_HOST, SCF_TYPE_HOSTNAME, SCF_TYPE_NET_ADDR_V4, SCF_TYPE_NET_ADDR_V6. | Sol:8.2 |
| value of <smf property> | <smf value> | Returns the value of an smf property. Each smf property represents a setting as a name/value pair. Although most smf property inspectors are only assigned a single value, it is possible for one to be assigned multiple values of the same type. The types that an smf value can have are BOOLEAN, COUNT, INTEGER, TIME, OPAQUE, ASTRING, USTRING, URI, HOST, FMRI, HOSTNAME, NET_ADDR_V4, and NET_ADDR_V6. | Sol:8.2 |
smf serviceCreation Methods| Declaration | Description | Platforms (?) |
| parent service of <smf instance> | Returns the smf service to which this instance belongs. Each service can have multiple instances which can share configuration with each other as well as maintain individual configuration and characteristics. | Sol:8.2 |
| parent service of <smf property group> | Returns the service to which this property group belongs. | Sol:8.2 |
| service <string> of <smf> | Returns the smf service object identified by the specified name. Services have unique names, so this is a singular property. An smf service inspector represents a type of service (such as 'web server') without specifying a particular piece of server software (such as 'Apache'). | Sol:8.2 |
| service of <smf> | Iterates over all installed smf service objects on the local machine. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf service> as string | <string> | Returns a string representation of an smf service object. This is the same as the name of the service. | Sol:8.2 |
| fmri of <smf service> | <smf fmri> | Returns an smf fmri object representing the 'Fault Management Resource Identifier' of a service. The FMRI is used to identify a service for administrative use. | Sol:8.2 |
| instance <string> of <smf service> | <smf instance> | Returns the specified instance of an smf service. An smf instance represents a particular piece of server software (such as 'Apache'). | Sol:8.2 |
| instance of <smf service> | <smf instance> | Iterates over the instances of a service. An smf instance represents a particular piece of server software (such as 'Apache'). | Sol:8.2 |
| name of <smf service> | <string> | Returns the name of the service. | Sol:8.2 |
| property group <string> of <smf service> | <smf property group> | Returns the specified property group of a service. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
| property group of <smf service> | <smf property group> | Iterates over the property groups of a service. An smf property group is a group of name/value pairs that represent configuration settings. Thus, there are some configuration settings that are applicable in general to a particular type of service, and others that are applicable only to a particular instance of a service. | Sol:8.2 |
smf snapshot partCreation Methods| Declaration | Description | Platforms (?) |
| parent snapshot part of <smf property group> | Returns an object that represents a part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
| instance part of <smf snapshot> | Represents an instance part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
| part of <smf snapshot> | Represents a part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
| service part of <smf snapshot> | Represents a service part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| parent snapshot of <smf snapshot part> | <smf snapshot> | Returns the snapshot to which this snapshot part belongs. | Sol:8.2 |
| property group <string> of <smf snapshot part> | <smf property group> | Returns the specified property group of a snapshot part. | Sol:8.2 |
| property group of <smf snapshot part> | <smf property group> | Iterates over the property groups of a snapshot part. | Sol:8.2 |
smf snapshotCreation Methods| Declaration | Description | Platforms (?) |
| snapshot <string> of <smf instance> | Returns the specified smf snapshot of a service instance. A snapshot is an unchanging picture of the full set of property groups associated with an instance. Snapshots are automatically created and managed by the Service Management Facility. A snapshot consists of a set of snaplevels, each of which holds copies of the property groups associated with an instance or service in the resolution path of the base instance. Typically, there is one snaplevel for the instance and one for the instance's parent service. | Sol:8.2 |
| snapshot of <smf instance> | Iterates over the snapshots of a service instance. A snapshot is an unchanging picture of the full set of property groups associated with an instance. Snapshots are automatically created and managed by the Service Management Facility. A snapshot consists of a set of snaplevels, each of which holds copies of the property groups associated with an instance or service in the resolution path of the base instance. Typically, there is one snaplevel for the instance and one for the instance's parent service. | Sol:8.2 |
| parent snapshot of <smf snapshot part> | Returns the snapshot to which this snapshot part belongs. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf snapshot> as string | <string> | A string representation of an smf snapshot. This is the same as the name of the snapshot. | Sol:8.2 |
| instance part of <smf snapshot> | <smf snapshot part> | Represents an instance part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
| name of <smf snapshot> | <string> | Returns the name of an smf snapshot. | Sol:8.2 |
| parent instance of <smf snapshot> | <smf instance> | Returns the service instance to which this snapshot belongs. | Sol:8.2 |
| part of <smf snapshot> | <smf snapshot part> | Represents a part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
| service part of <smf snapshot> | <smf snapshot part> | Represents a service part of an smf snapshot. Each snapshot has two parts: a 'service part' and an 'instance part'. | Sol:8.2 |
smf timeCreation Methods| Declaration | Description | Platforms (?) |
| <smf value> as smf time | Returns an smf time object for values of type SCF_TYPE_TIME. Returns type conversion error for other types. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf time> as string | <string> | Returns a string representation of an smf time. An smf time consists of a seconds portion and a nanoseconds portion. | Sol:8.2 |
| nanoseconds value of <smf time> | <integer> | Returns a number corresponding to the nanoseconds portion of an smf time. | Sol:8.2 |
| seconds value of <smf time> | <integer> | Returns a number corresponding to the seconds portion of an smf time. | Sol:8.2 |
smf valueCreation Methods| Declaration | Description | Platforms (?) |
| value of <smf property> | Returns the value of an smf property. Each smf property represents a setting as a name/value pair. Although most smf property inspectors are only assigned a single value, it is possible for one to be assigned multiple values of the same type. The types that an smf value can have are BOOLEAN, COUNT, INTEGER, TIME, OPAQUE, ASTRING, USTRING, URI, HOST, FMRI, HOSTNAME, NET_ADDR_V4, and NET_ADDR_V6. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <smf value> as boolean | <boolean> | Returns the boolean state for values of type SCF_TYPE_BOOLEAN. Returns type conversion error for other types. | Sol:8.2 |
| <smf value> as integer | <integer> | Returns the numeric value for values of type SCF_TYPE_INTEGER or SCF_TYPE_COUNT. Returns type conversion error for other types. | Sol:8.2 |
| <smf value> as smf time | <smf time> | Returns an smf time object for values of type SCF_TYPE_TIME. Returns type conversion error for other types. | Sol:8.2 |
| <smf value> as string | <string> | Returns a string representation of the value for all types of smf values. | Sol:8.2 |
| type of <smf value> | <string> | Returns a string representation of the type of an smf value. These types can have values of SCF_TYPE_INVALID, SCF_TYPE_BOOLEAN, SCF_TYPE_COUNT, SCF_TYPE_INTEGER, SCF_TYPE_TIME, SCF_TYPE_ASTRING, SCF_TYPE_OPAQUE, SCF_TYPE_USTRING, SCF_TYPE_URI, SCF_TYPE_FMRI, SCF_TYPE_HOST, SCF_TYPE_HOSTNAME, SCF_TYPE_NET_ADDR_V4, SCF_TYPE_NET_ADDR_V6. | Sol:8.2 |
smfCreation Methods| Declaration | Description | Platforms (?) |
| smf | Returns the smf object. Use 'services of smf' for more information. | Sol:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| service <string> of <smf> | <smf service> | Returns the smf service object identified by the specified name. Services have unique names, so this is a singular property. An smf service inspector represents a type of service (such as 'web server') without specifying a particular piece of server software (such as 'Apache'). | Sol:8.2 |
| service of <smf> | <smf service> | Iterates over all installed smf service objects on the local machine. | Sol:8.2 |
aparCreation Methods| Declaration | Description | Platforms (?) |
| apar <string> of <operating system> | Returns the APAR whose APAR number exactly matches the string. | AIX:8.2 |
| apar of <operating system> | Returns all APARs. | AIX:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <apar> as string | <string> | Returns a string containing the APAR number. | AIX:8.2 |
| abstract of <apar> | <string> | Returns a string containing a short description of the APAR. | AIX:8.2 |
| fileset version requirement <string> of <apar> | <fileset version requirement> | Returns the fileset version requirement for the APAR if a fileset with the LPP name that matches the string is a requirement for the APAR. | AIX:8.2 |
| fileset version requirement of <apar> | <fileset version requirement> | Returns all the required filesets version requirements for the APAR. | AIX:8.2 |
| installed satisfied fileset version requirement of <apar> | <fileset version requirement> | Returns all the fileset version requirements for the APAR that are installed and meet the version requirement. | AIX:8.2 |
| installed unsatisfied fileset version requirement of <apar> | <fileset version requirement> | Returns all the fileset version requirements for the APAR that are installed but do not meet the version requirement. | AIX:8.2 |
| name of <apar> | <string> | Returns a string containing the APAR number. | AIX:8.2 |
| symptom of <apar> | <string> | Returns a string with the visible symptoms exhibited by the APAR. The string may be empty. | AIX:8.2 |
| uninstalled fileset version requirement of <apar> | <fileset version requirement> | Returns all the fileset version requirements for the APAR that are not installed. | AIX:8.2 |
biosCreation Methods| Declaration | Description | Platforms (?) |
| <bios> | Create the bios object | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <bios> | <bios> | Create the bios object | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| <bios> as string | <string> | This Windows-only Inspector returns a string that is the concatenation of the BIOS name and date. On a non-Windows operating system, it returns FALSE. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| date of <bios> | <string> Plural: dates | This Windows-only Inspector returns the date string stored in the bios. This string is formatted as MM/DD/YY. On a non-Windows operating system, it returns FALSE. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| version of <bios> | <string> Plural: versions | This Windows-only Inspector returns the first string of the multi-string version stored in the bios. This string may not exist. The format depends upon your BIOS manufacturer. On a non-Windows operating system, it returns FALSE. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| version string of <bios> | <string> Plural: version strings | Win:8.2 |
operating systemCreation Methods| Declaration | Description | Platforms (?) |
| operating system | Returns the operating system object. See operating system. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <operating system> as string | <string> | Returns a string containing the name of the operating system concatenated with the release. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| apar <string> of <operating system> | <apar> Plural: apars | Returns the APAR whose APAR number exactly matches the string. | AIX:8.2 |
| apar of <operating system> | <apar> Plural: apars | Returns all APARs. | AIX:8.2 |
| architecture of <operating system> | <string> Plural: architectures | Returns the architecture of the operating system. This is the value of the 'machine' element of the utsname structure obtained by calling uname. | Win:8.2, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| boot time of <operating system> | <time> Plural: boot times | Returns the time of the last restart. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| build number high of <operating system> | <integer> Plural: build number highs | Numeric representation of the most significant 16 bits of the build number. | Win, WM |
| build number low of <operating system> | <integer> Plural: build number lows | Numeric representation of the least significant 16 bits of the build number. | Win, WM |
| build number of <operating system> | <integer> Plural: build numbers | This Inspector returns the build number of the specified OS. On Windows, the Inspector returns an integer. This is the value of the dwBuildNumber member of the OSVERSIONINFO structure returned by the GetVersionEx Windows API. | Win |
| build number of <operating system> | <string> Plural: build numbers | Returns as a string the third element of the OS version. For example, if the OS version is "x.y.z.w", this inspector returns "z". | Mac |
| build of <operating system> | <string> Plural: builds | Returns a string corresponding to the build number of the OS. | Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| codename of <operating system> | <string> Plural: codenames | This *NIX Inspector returns a string that corresponds to the codename of the given release. For example, Ubuntu 8.04 has the codename of 'hardy'. | Lin:8.1, Sol:8.1, HPUX:8.1, AIX:8.1, Ubu:8.1 |
| csd version of <operating system> | <string> Plural: csd versions | Returns the Corrective Service Disk version of the operating system. The szCSDVersion as returned by the GetVersionEx system call. The format varies depending on the installed service packs. For WinNT it contains a string such as "Service Pack 3", for Win95 it can contain a string such as "B". | Win, WM |
| current service pack of <operating system> | <service pack> Plural: current service packs | Returns the current service pack, or no such object if none have been applied at the current technology level. | AIX:8.2 |
| current technology level of <operating system> | <technology level> Plural: current technology levels | Returns the current technology level. This also includes the base level information, similar to 'oslevel -r'. | AIX:8.2 |
| ia64 of <operating system> | <boolean> Plural: ia64s | Returns TRUE iff the BES Client is running on Itanium. | Win, WM |
| mac of <operating system> | <boolean> Plural: macs | Returns TRUE if the client computer is a Macintosh. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
| machine of <operating system> | <string> Plural: machines | Returns the architecture of the machine. | Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2 |
| major version of <operating system> | <integer> Plural: major versions | Returns integer which is the dwMajorVersion returned by the GetVersionEx system call. Note that while the WinNT major version tracks the release (3 for 3.51, 4 for 4.0, and 5.0 for Windows 2000, 5.1 for Windows XP), the major version for Win95 and Win98 is always 4. | Win, WM |
| metric <integer> of <operating system> | <integer> Plural: metrics | This inspector uses the windows GetSystemMetrics API. The integer constants and their meaning are defined by Microsoft. For example, the integer 87 indicates that the operating system is a media center edition. The integer constants are defined in WinUser.h. | Win |
| minor version of <operating system> | <integer> Plural: minor versions | Numeric representation of the minor version of the operating system. | Win, WM |
| name of <operating system> | <string> Plural: names | Returns the name of the operating system as a string. Names might include Win98, WinNT, etcetera. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| performance counter frequency of <operating system> | <hertz> Plural: performance counter frequencies | The rate at which the performance counter is being incremented (per second). | Win, WM |
| performance counter of <operating system> | <integer> Plural: performance counters | Retrieves a 64-bit performance counter value. | Win, WM |
| platform id of <operating system> | <integer> Plural: platform ids | Returns the dwPlatformId as returned by the GetVersionEx system call. Possible values are 1 (Win95/95) and 2 (WinNT). | Win, WM |
| product info numeric of <operating system> | <integer> Plural: product info numerics | This Windows-specific inspector returns the integer from the Windows GetProductInfo API. The inspector only provides meaningful results for Windows Vista and newer versions of the OS. The major/minor version of the OS must be 6.0 or greater for the result to be meaningful. For more information, refer to the Microsoft article at http://msdn2.microsoft.com/en-us/library/ms724358(VS.85).aspx. | Win, WM |
| product info string of <operating system> | <string> Plural: product info strings | On Windows versions 6.0 and newer (Vista minimum), this inspector returns a string derived from the GetProductInfo API. It will be one of the following values:UnlicensedBusinessCluster ServerServer DatacenterServer Datacenter CoreEnterpriseServer EnterpriseServer Enterprise CoreServer Enterprise ItaniumHome BasicHome ServerServer for Small BusinessSmall Business ServerSmall Business Server PremiumServer StandardServer Standard CoreStarterStorage Server EnterpriseStorage Server StandardStorage Server WorkgroupUltimateWeb ServerUnknown. | Win, Mac:8.2, WM |
| product type of <operating system> | <operating system product type> Plural: product types | Returns the product type of the operating system, which includes Workstations, Domain Controllers and Servers. | Win, WM |
| release of <operating system> | <string> Plural: releases | Information about the release of the operating system, formatted as a <version> on the Macintosh, but a <string> on UNIX and Windows. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| service pack <string> of <operating system> | <service pack> Plural: service packs | Returns the service pack that matches the string in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'. | AIX:8.2 |
| service pack major version of <operating system> | <integer> Plural: service pack major versions | Returns the major version number of the current service pack of the specified OS. | Win, WM |
| service pack minor version of <operating system> | <integer> Plural: service pack minor versions | Returns the minor version number of the current service pack of the specified OS. | Win, WM |
| service pack of <operating system> | <service pack> Plural: service packs | Returns all service packs | AIX:8.2 |
| suite mask of <operating system> | <operating system suite mask> Plural: suite masks | Returns the bit-mapped suite mask for the operating system, which contains further fine-grain information about the version. | Win, WM |
| technology level <string> of <operating system> | <technology level> Plural: technology levels | Returns the technology level that matches the string in the format "base-tl". For example, AIX 5.3 at technology level 6 is "5300-06". | AIX:8.2 |
| technology level of <operating system> | <technology level> Plural: technology levels | Returns all technology levels. | AIX:8.2 |
| unix of <operating system> | <boolean> Plural: unixes | Returns TRUE if the local computer is a UNIX system. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
| uptime of <operating system> | <time interval> Plural: uptimes | Returns a time interval that represents the elapsed time since the operating system was last booted. Note: Depending on the notebook, this interval may not include time spent in hibernation. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| version of <operating system> | <version> Plural: versions | Returns the version of the operating system. | Win:8.0, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.0, Ubu:8.2 |
| windows of <operating system> | <boolean> Plural: windowses | Returns TRUE if the local computer is a Windows system. | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1 |
| x64 of <operating system> | <boolean> Plural: x64s | Returns TRUE if the current operating system is 64-bits. | Win, WM |
cpupackageCreation Methods| Declaration | Description | Platforms (?) |
| cpupackage | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 |
Properties| Declaration | Return type | Description | Platforms (?) |
| core of <cpupackage> | <integer> | Returns the number of physical cores in a single cpupackage (a single socket or physical CPU) | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 |
| count of <cpupackage> | <integer> | Returns the count of physical cpu packages packages (the number of sockets or physical CPUs). Multiply this number by the number of cores to get the total core count of the system. | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 |
| smt capable of <cpupackage> | <boolean> | If detectable, returns true if the cpupackage is capable of SMT threads (Simultaneous multithreading, called "Hyper-Threading" on some platforms) | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 |
| smt enabled of <cpupackage> | <boolean> | If detectable, returns true if the cpupackage is using SMT threads (Simultaneous multithreading, called Hyper-Threading on some platforms) | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 |
| thread of <cpupackage> | <integer> | Returns the number of SMT threads (Simultaneous multithreading, called Hyper-Threading on some platforms) in a single cpupackage (a single socket or physical CPU) | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 |
processorCreation Methods| Declaration | Description | Platforms (?) |
| main processor | Returns the processor object corresponding to the main processor. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| processor | Returns all the processor objects defined on the machine. See processor. Example: number of processors > 1 - Returns TRUE if the computer is a multi-processor system. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| processor <integer> | Returns a processor object for the numbered processor. Processors are numbered from 1. | Win, Lin, Sol, HPUX, AIX, Mac:8.2, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| extended feature mask of <processor> | <integer> Plural: extended feature masks | Returns a mask of the extended feature bits of an x86 processor | Ubu:9.0, Lin:9.0, Mac:9.0, Win:9.0 |
| adjustment <integer> of <processor> | <integer> Plural: adjustments | s390 processors only. Returns the processor Adjustment Way (guest performance) | Lin:8.2 |
| bogomips of <processor> | <integer> Plural: bogomipses | Returns the Bogomips of the specified processor, which provides a rough indication of its speed. | Lin, Ubu:8.1 |
| brand id of <processor> | <integer> Plural: brand ids | This inspector returns the integer known as the brand id, returned from the assembly language cpuid extended instruction. | Win, Mac:8.2, WM |
| brand string of <processor> | <string> Plural: brand strings | Returns the vendor-defined brand names for newer processors. | Win, Lin:8.2, Sol:8.2, Mac:8.2, WM, Ubu:8.2 |
| capability of <processor> | <integer> Plural: capabilitys | s390 processors only. Returns the capability code of the processor | Lin:8.2 |
| coma bug of <processor> | <boolean> Plural: coma bugs | Returns TRUE if the specified processor is afflicted by the coma bug. The coma bug afflicts certain Cyrix CPUs, causing them to occasionally lock up. The affected CPUs include the Cyrix/IBM 6x86, 6x86L, and 6x86MX. | Lin, Ubu:8.1 |
| cpuid level of <processor> | <integer> Plural: cpuid levels | Returns an integer corresponding to the cpuid level for the given processor. | Lin, Ubu:8.1 |
| cpus configured of <processor> | <integer> Plural: cpus configureds | s390 processors only. Returns the number of processors configured for the system | Lin:8.2 |
| cpus reserved of <processor> | <integer> Plural: cpus reserveds | s390 processors only. Returns the number of processors reserved for the system | Lin:8.2 |
| cpus standby of <processor> | <integer> Plural: cpus standbys | s390 processors only. Returns the number of processors in standby for the system | Lin:8.2 |
| cpus total of <processor> | <integer> Plural: cpus totals | s390 processors only. Returns the number of total processors for the system | Lin:8.2 |
| extended family of <processor> | <integer> Plural: extended families | Integer representing the extended family of CPU. See the notes for the meaning of these numbers. | Win, Mac:8.2, WM |
| extended model of <processor> | <integer> Plural: extended models | Integer representing the extended model of CPU. See the notes for the meaning of these numbers. | Win, Mac:8.2, WM |
| f00f bug of <processor> | <boolean> Plural: f00f bugs | Returns TRUE if the specified processor is afflicted by the f00f bug. This bug is named after the first two of a four-byte assembly language sequence that can freeze up x86 Pentium processors. | Lin, Ubu:8.1 |
| family name of <processor> | <string> Plural: family names | Returns the family name of the CPU, dependent on the type of client computer, for instance Pentium, Sparc, PowerPC G4, etcetera. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| family of <processor> | <integer> Plural: families | Returns an integer representing the family of the CPU. See the notes for the meaning of these numbers. As of BES 6.0, this Inspector returns a string on Solaris and AIX computers. | Win, Lin, Sol, AIX, Mac:8.2, WM, Ubu:8.1 |
| family of <processor> | <string> Plural: families | Returns an integer representing the family of the CPU. See the notes for the meaning of these numbers. As of BES 6.0, this Inspector returns a string on Solaris and AIX computers. | Sol, AIX |
| fdiv bug of <processor> | <boolean> Plural: fdiv bugs | Returns TRUE if the specified processor is afflicted by the fdiv bug, which occasionally causes incorrect floating point division answers. | Lin, Ubu:8.1 |
| feature mask of <processor> | <integer> Plural: feature masks | Returns the feature flags from the CPUID instruction. The feature mask contains bits that identify extra features the processor may provide such as MMX support or if the Processor ID is enabled on the processor. | Win, Mac:8.2, WM |
| flag list of <processor> | <string> Plural: flag lists | Returns a string containing the processor flags. To check if a processor has a particular flag, use the 'contains' operator. | Lin, Ubu:8.1 |
| fpu exception of <processor> | <boolean> Plural: fpu exceptions | Returns TRUE if the fpu exception has occurred on this processor. | Lin, Ubu:8.1 |
| fpu of <processor> | <boolean> Plural: fpus | Returns TRUE if the specified processor contains a floating point unit. | Lin, Ubu:8.1 |
| fputype of <processor> | <string> Plural: fputypes | Returns pi_fputypes, a string containing the comma-separated types of floating-point units (FPUs) attached to the processor. This string will be empty if no FPU is attached. | Sol |
| hlt bug of <processor> | <boolean> Plural: hlt bugs | Returns TRUE if the specified processor is afflicted by the hlt bug. | Lin, Ubu:8.1 |
| id of <processor> | <integer> Plural: ids | Returns an integer corresponding to the ID of the specified processor. | Sol, AIX |
| index of <processor> | <integer> Plural: indexes | Returns the ordinal number of the processor on a multi processor machine. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
| lpar adjustment of <processor> | <integer> Plural: lpar adjustments | s390 processors only. Returns the LPAR agjustment for the processor | Lin:8.2 |
| lpar characteristics of <processor> | <string> Plural: lpar characteristicss | s390 processors only. Returns the characteristic of the processor. ie: Shared | Lin:8.2 |
| lpar cpus configured of <processor> | <integer> Plural: lpar cpus configureds | s390 processors only. Returns the number of processors configured for the LPAR | Lin:8.2 |
| lpar cpus dedicated of <processor> | <integer> Plural: lpar cpus dedicateds | s390 processors only. Returns the number of processors dedicated for the LPAR | Lin:8.2 |
| lpar cpus reserved of <processor> | <integer> Plural: lpar cpus reserveds | s390 processors only. Returns the number of processors reserved for the LPAR | Lin:8.2 |
| lpar cpus shared of <processor> | <integer> Plural: lpar cpus shareds | s390 processors only. Returns the number of processors shared for the LPAR | Lin:8.2 |
| lpar cpus standby of <processor> | <integer> Plural: lpar cpus standbys | s390 processors only. Returns the number of processors in standby for the LPAR | Lin:8.2 |
| lpar cpus total of <processor> | <integer> Plural: lpar cpus totals | s390 processors only. Returns the total number of processors for the LPAR | Lin:8.2 |
| lpar name of <processor> | <string> Plural: lpar names | s390 processors only. Returns the name of the processor for the LPAR | Lin:8.2 |
| lpar number of <processor> | <integer> Plural: lpar numbers | s390 processors only. Returns the LPAR number for this processor | Lin:8.2 |
| machine serial number of <processor> | <string> Plural: machine serial numbers | s390 processors only. Returns the serial number of the processor | Lin:8.2 |
| model name of <processor> | <string> Plural: model names | Returns a string containing the name of the processor model. | Lin, Ubu:8.1 |
| model of <processor> | <integer> Plural: models | Returns the model number of the CPU.Note: On Solaris, HPUX and AIX computers, this Inspector returns a <string> as of BES 6.0. | Win, Lin, Mac:8.2, WM, Ubu:8.1 |
| model of <processor> | <string> Plural: models | Returns the model number of the CPU as a string.Note: On Windows and Linux platforms, this Inspector returns an integer. | Sol, HPUX, AIX |
| sep bug of <processor> | <boolean> Plural: sep bugs | Returns TRUE if the given processor improperly reports the value of its SEP (Sysenter/sysexit Present) flag. | Lin, Ubu:8.1 |
| sequence code of <processor> | <string> Plural: sequence codes | s390 processors only. Returns the Sequence Code for the processor. | Lin:8.2 |
| speed of <processor> | <hertz> Plural: speeds | Returns the speed of the processor in Hertz. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| state of <processor> | <string> Plural: states | Returns the current processor state, which can be "online", "offline", "poweroff", or "unknown". | Sol, HPUX |
| stepping of <processor> | <integer> Plural: steppings | Returns the stepping number of the processor. This item can be helpful in identifying very specific processor features or limitations. | Win, Lin, Mac:8.2, WM, Ubu:8.1 |
| type of <processor> | <integer> Plural: types | Numeric type of the CPU. Values include: 0 - standard1 - overdrive2 - dual CPU capable3 - reservedNote: this Inspector returns a <string> type as of BES version 6.0 on UNIX machines and version 5.1 on the Macintosh. | Win, WM |
| type of <processor> | <string> Plural: types | Numeric type of the CPU. Values include: 0 - standard1 - overdrive2 - dual CPU capable3 - reservedNote: this Inspector returns an <integer> type as on Windows platforms. | Sol, AIX, Mac |
| vendor name of <processor> | <string> Plural: vendor names | The manufacturer of the CPU. Names include: GenuineIntelAuthenticAMDCyrixInsteadCentaurHaulsAmbiguousCPU. | Win, Lin, Mac:8.2, WM, Ubu:8.1 |
| version of <processor> | <string> Plural: versions | The hardware version of the cpu. | HPUX |
| vm adjustment of <processor> | <integer> Plural: vm adjustments | s390 processors only. Returns the VM Adjustment for the processor | Lin:8.2 |
| vm control program of <processor> | <string> Plural: vm control programs | s390 processors only. Returns the VM Control Program for the processor. ie: z/VM 5.2.0 | Lin:8.2 |
| vm cpus configured of <processor> | <integer> Plural: vm cpus configureds | s390 processors only. Returns the number of processors configured for the VM | Lin:8.2 |
| vm cpus reserved of <processor> | <integer> Plural: vm cpus reserveds | s390 processors only. Returns the number of processors configured for the VM | Lin:8.2 |
| vm cpus standby of <processor> | <integer> Plural: vm cpus standbys | s390 processors only. Returns the number of processors in standby for the VM | Lin:8.2 |
| vm cpus total of <processor> | <integer> Plural: vm cpus totals | s390 processors only. Returns the total number of processors for the VM | Lin:8.2 |
| vm name of <processor> | <string> Plural: vm names | s390 processors only. Returns the name of the VM | Lin:8.2 |
| wp of <processor> | <boolean> Plural: wps | Returns TRUE if the specified processor has the WP feature. | Lin, Ubu:8.1 |
ramCreation Methods| Declaration | Description | Platforms (?) |
| ram | Returns a ram object for inspecting the properties of Random Access Memory installed on the machine. See ram. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| random access memory | Same as above. | Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| available amount of <ram> | <integer> Plural: available amounts | Returns the amount of system ram that is currently available, in bytes. | Lin, Ubu:8.1 |
| available of <ram> | <integer> Plural: availables | Returns the total amount of RAM (in bytes) currently available on the Windows Mobile device. This is the same as for for the Windows client. | WM |
| buffered amount of <ram> | <integer> Plural: buffered amounts | Returns the amount of system RAM currently buffered, in bytes. | Lin, Ubu:8.1 |
| cached amount of <ram> | <integer> Plural: cached amounts | Returns the amount of system RAM currently cached, in bytes. | Lin, Ubu:8.1 |
| free amount of <ram> | <integer> Plural: free amounts | Returns the amount of system RAM currently unused, in bytes. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
| load of <ram> | <integer> Plural: loads | Returns the amount of memory being used on the Windows Mobile device as a percentage. 0 = no memory used, 100 = all memory used. This is the same as for the Windows client. | WM |
| shared amount of <ram> | <integer> Plural: shared amounts | Returns the amount of system RAM currently shared, in bytes. | Lin, Ubu:8.1 |
| size of <ram> | <integer> Plural: sizes | Returns the number of bytes of random access memory on the current machine. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| total amount of <ram> | <integer> Plural: total amounts | Same as size of <ram>. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
| unavailable amount of <ram> | <integer> Plural: unavailable amounts | Returns the amount of system RAM currently unavailable, in bytes. | Lin, Ubu:8.1 |
| used amount of <ram> | <integer> Plural: used amounts | Returns the amount of system RAM currently used, in bytes. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
active deviceCreation Methods| Declaration | Description | Platforms (?) |
| active device | Returns a list of all active devices found using the Configuration Manager SetupDiGetClassDevs NT API. Example: number of active devices - Returns the number of active devices as determined by the Configuration Manager. Example: exists active device file "system32\ntoskrnl.exe" - Returns TRUE if ntoskrnl.exe exists in the System32 folder of the Windows folder. Example: exists active device file "C:\WINNT\System32\ntoskrnl.exe" - Returns FALSE because this Inspector path is relative to the Windows directory. | Win |
Properties| Declaration | Return type | Description | Platforms (?) |
| class of <active device> | <string> Plural: classes | Returns the name of the class of the active device provided. | Win |
| description of <active device> | <string> Plural: descriptions | Returns the description of the active device provided. | Win |
| driver key of <active device> | <registry key> Plural: driver keys | The key identified by adding the value of 'driver key value name of active device' to HKLM\System\CurrentControlSet\Control\Class\. | Win |
| driver key value name of <active device> | <string> Plural: driver key value names | Returns the driver key value name of the active device provided. | Win |
| friendly name of <active device> | <string> Plural: friendly names | Returns the friendly name of the active device. | Win |
| hardware id of <active device> | <string> Plural: hardware ids | Returns the hardware id of the active device provided. | Win |
| location information of <active device> | <string> Plural: location informations | Returns a string containing information about the bus location of the device. | Win |
| manufacturer of <active device> | <string> Plural: manufacturers | Returns the manufactures string of the active device. | Win |
| problem id of <active device> | <integer> Plural: problem ids | Configuration manager defined number describing device installation or use problems. Returned by call to CM_Get_DevInst_Status. | Win |
| service key value name of <active device> | <string> Plural: service key value names | Returns the service key value name. | Win |
| status of <active device> | <integer> Plural: statuss | Configuration manager defined status bits conveying device driver status. | Win |
local mssql databaseCreation Methods| Declaration | Description | Platforms (?) |
| local mssql database | Returns local MSSQL database objects. | Win |
| local mssql database <string> | Returns the local Microsoft SQL (MSSQL) database object identified by the name provided. | Win |
Properties| Declaration | Return type | Description | Platforms (?) |
| audit level of <local mssql database> | <integer> Plural: audit levels | Returns the integer audit level of the MSSQL database. | Win |
| has blank sa password of <local mssql database> | <boolean> Plural: has blank sa passwords | Returns TRUE if the MSSQL database sa account has a blank password. | Win |
| instance name of <local mssql database> | <string> Plural: instance names | Returns the name of the MSSQL database. | Win |
| login mode of <local mssql database> | <integer> Plural: login modes | Returns the login mode of the MSSQL database. | Win |
| running of <local mssql database> | <boolean> Plural: runnings | Returns a boolean indicating if the MSSQL database is running. | Win |
serviceCreation Methods| Declaration | Description | Platforms (?) |
| all running service | Returns a list of all running Windows 32 services, such as ATAPI and BESRelay. | Win:8.1 |
| all service | Returns a list of all Windows 32 services, including the BESRelay. | Win:8.1 |
| driver running service | Returns a list of all running Windows 32 system drivers. | Win:8.1 |
| driver service | Returns a list of all Windows 32 system drivers. | Win:8.1 |
| main gather service | Returns a service object for the main gathering service, typically located on the main server.Note: On a Macintosh, returns <nothing>. Included for compatibility. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| relay service | Returns a service object for the relay component of BES. Note: On a Macintosh, this returns <nothing>. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| running service | Returns all the running service objects. Example: running services - Returns a list of all the currently running services. | Win |
| running service <string> | Returns the running service object matching the name provided. | Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1 |
| service | Returns all the service objects. | Win |
| service <string> | Returns the service object matching the name provided, regardless of its running state.On a Macintosh, returns a <dummy> type. | Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| win32 running service | A synonym for 'running service'. This can be any running service from atapi to the BESRelay. | Win:8.1 |
| win32 service | A synonym for 'service'. This can be anything from atapi to the BESRelay. | Win:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| proxy agent service | service Plural: proxy agent services | Returns a service object of the BESProxyAgent if one is present | Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0 |
| <service> as string | <string> | Returns a string containing the Service name, Display name, and State of the service. | Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2 |
| can interact with desktop of <service> | <boolean> Plural: can interact with desktops | Indicates the system is configured to allow the service to interact with the desktop. | Win |
| checkpoint of <service> | <integer> Plural: checkpoints | Service specific value indicating its checkpoint state. | Win |
| display name of <service> | <string> Plural: display names | Returns the display name of the service. | Win |
| driver type of <service> | <boolean> Plural: driver types | Returns true if the specified service is a driver type. | Win:8.1 |
| file of <service> | <file> Plural: files | Returns a file object corresponding to the specified <service>. | Win |
| image path of <service> | <string> Plural: image paths | Returns the full path to the service executable. | Win |
| login account of <service> | <string> Plural: login accounts | Returns the login account under which the service is configured to run. | Win |
| running of <service> | <boolean> Plural: runnings | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2 | |
| security descriptor of <service> | <security descriptor> Plural: security descriptors | This Windows-specific Inspector returns a security descriptor for the specified service. | Win |
| service name of <service> | <string> Plural: service names | Returns the name of the service. | Win |
| service specific exit code of <service> | <integer> Plural: service specific exit codes | Service specific exit code. | Win |
| start type of <service> | <string> Plural: start types | Returns a string that represents the service startup configuration. It describes when the driver is loaded, which can be one of:boot: started by OS loader (usually these are needed to launch the OS).system: started during OS initialization (used by PnP drivers that do device detection after the loader is finished).auto: started by the Service Control Manager (SCM).demand: started on demand, either by PnP manager when a device is enumerated or by the SCM in response to user demand.disabled: can't be started (used to temporarily disable driver services). | Win |
| state of <service> | <string> Plural: states | Returns one of Continuing, Pausing, Paused, Running, Starting, Stopping, Stopped, Unknown. | Win, Lin, Sol, HPUX, AIX, Ubu:8.1 |
| version of <service> | <version> Plural: versions | This Inspector takes the specified service property and retrieves its version (file version). | Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1 |
| win32 exit code of <service> | <integer> Plural: win32 exit codes | Service specific Win32 exit code. | Win |
| win32 type of <service> | <boolean> Plural: win32 types | Returns true if the specified service is a Win32 type. | Win:8.1 |
processCreation Methods| Declaration | Description | Platforms (?) |
| process | Returns all process objects currently running. On AIX returns the name of the executable files spawning the processes. | Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| process <integer> | Returns the process object corresponding to the given integer pid. | Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| process <string> | Returns the process object corresponding to the name specified by <string>. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
| init process of <zone> | Returns the init process of the specified Solaris Zone. An attempt to get the init process of an inactive zone will result in 'Singular expression refers to nonexistent object'. See the Solaris documentation for more information. | Sol:8.0 |
| process of <socket> | Returns a <process> representing the local owner of the socket | Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| effective user of <process> | <user> Plural: effective users | Returns the effective user of the process specified | Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0 |
| ppid of <process> | <integer> Plural: ppids | Returns the PPID of the process specified | Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0 |
| base priority of <process> | <priority class> Plural: base priorities | Refers to the base priority of the process, which determines the order in which threads are scheduled for the processor. The base priority is set by the process code (not the OS), however the OS sets and changes the dynamic priorities of threads in the process within the range of the base. Use the Task Manager to change the base priority of processes. | Win:8.0 |
| command line argument <integer> of <process> | <string> Plural: command line arguments | Returns the Nth command line argument of the specified process. | Lin:8.0, Sol:8.0, AIX:8.0, Ubu:8.1 |
| command line argument of <process> | <string> Plural: command line arguments | Returns the command line arguments of the specified process. | Lin:8.0, Sol:8.0, AIX:8.0, Ubu:8.1 |
| creation time of <process> | <time> Plural: creation times | Returns the creation time of the specified process as a time type. | Win:8.0 |
| environment of <process> | <environment> Plural: environments | Returns the environment of the specified process. | Lin:8.0, Sol:8.0, Ubu:8.1 |
| gdi object count of <process> | <integer> Plural: gdi object counts | Returns the count of the GDI (Graphics Device Interface) objects associated with the specified process as an integer. | Win:8.0 |
| handle count of <process> | <integer> Plural: handle counts | Refers to the number of object handles in the object table of the specified process. | Win:8.0 |
| id of <process> | <integer> Plural: ids | Returns the integer ID of the specified process. | Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| image file of <process> | <file> Plural: image files | Returns a file object representing the image file used to launch the process. In some cases, this subproperty may not exist. For example, the "System" process does not have an image file. | Win:8.0 |
| io other count of <process> | <integer> Plural: io other counts | Refers to the number of I/O process operations that are neither reads nor writes, including file, network, and device I/O, but excluding I/O directed to the console input object handles. An example might be a control function. | Win:8.0 |
| io other size of <process> | <integer> Plural: io other sizes | Refers to the number of bytes transferred in I/O operations generated by a process including file, network, and device I/Os but excluding reads, writes and bytes directed to the console input object. | Win:8.0 |
| io read count of <process> | <integer> Plural: io read counts | Refers to the number of read I/O operations generated by a process, including file, network, and device I/Os, but excluding I/O reads directed to the console input object handles. | Win:8.0 |
| io read size of <process> | <integer> Plural: io read sizes | Refers to the number of bytes read in I/O operations generated by a process, including file, network, and device I/Os, but excluding read bytes directed to the console input object handles. | Win:8.0 |
| io write count of <process> | <integer> Plural: io write counts | Refers to the number of write I/O operations generated by a process, including file, network, and device I/Os, but excluding I/O writes directed to the console input object handles. | Win:8.0 |
| io write size of <process> | <integer> Plural: io write sizes | Refers to the number of bytes written in I/O operations generated by a process, including file, network, and device I/Os, but excluding write bytes directed to the console input object handles. | Win:8.0 |
| kernel time of <process> | <time interval> Plural: kernel times | Returns the time in kernel mode, as a time interval. | Win:8.0 |
| name of <process> | <string> Plural: names | Returns the name (as a string) of the specified process. | Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| page fault count of <process> | <integer> Plural: page fault counts | Returns the number of page faults generated by the specified process. | Win:8.0 |
| page file usage of <process> | <integer> Plural: page file usages | Returns the amount of page file space used by the specified process. This value is equal to the VMSize in TaskMgr. | Win:8.0 |
| peak page file usage of <process> | <integer> Plural: peak page file usages | Returns the maximum page file space used throughout the lifetime of the specified process. | Win:8.0 |
| peak working set size of <process> | <integer> Plural: peak working set sizes | Returns the size of the peak working set of the specified process. | Win:8.0 |
| pid of <process> | <integer> Plural: pids | Returns the integer process ID for the specified process. | Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| process id of <process> | <integer> Plural: process ids | Returns the integer process ID for the specified process. | Lin, Sol, HPUX, AIX, Mac, Ubu:8.1 |
| quota nonpaged pool usage of <process> | <integer> Plural: quota nonpaged pool usages | Returns the quota amount of nonpaged pool usage for the specified process. | Win:8.0 |
| quota paged pool usage of <process> | <integer> Plural: quota paged pool usages | Returns the quota amount of paged pool usage for the specified process. | Win:8.0 |
| quota peak nonpaged pool usage of <process> | <integer> Plural: quota peak nonpaged pool usages | Returns the peak quota amount of nonpaged pool usage for the specified process. | Win:8.0 |
| quota peak paged pool usage of <process> | <integer> Plural: quota peak paged pool usages | Returns the peak quota amount of paged pool usage for the specified process. | Win:8.0 |
| selinux context of process<process> | <string> Plural: selinux contexts | Returns any security context for the specified process. | Lin: 9.2 |
| session id of <process> | <integer> Plural: session ids | Returns the ID of the session under which the process is running. This requires Win2000 or later and corresponds to the 'Session ID' column in Task Manager. | Win:8.0 |
| user object count of <process> | <integer> Plural: user object counts | Returns the count of USER objects associated with the specified process as an integer. | Win:8.0 |
| user of <process> | <security identifier> Plural: users | Returns a security identifier associated with the user of specified process. This Inspector requires Terminal Services or Win2000+, and may not be available if the inspector application does not have sufficient permissions. This object corresponds to the 'User Name' column in Task Manager. | Win:8.0 |
| user time of <process> | <time interval> Plural: user times | Returns the time in user mode as a time interval. | Win:8.0 |
| working set size of <process> | <integer> Plural: working set sizes | Returns the amount of memory (as an integer number of bytes) required by a process for efficient execution under an operating system that uses paged memory. Thrashing may occur in systems without sufficient memory. This value allow you to monitor the changing memory requirements of the specified process. | Win:8.0 |
| wow64 of <process> | <boolean> Plural: wow64s | Returns a boolean TRUE if the specified process is a 32-bit process running in WOW64 compatibility mode. Always returns FALSE on pre-WinXP SP2. | Win:8.0 |
| zone of <process> | <zone> Plural: zones | Returns the Solaris Zone corresponding to the specified process. | Sol:8.0 |
swapCreation Methods| Declaration | Description | Platforms (?) |
| swap | Returns an object containing information about the swap partition. | Lin, HPUX, AIX, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| free amount of <swap> | <integer> Plural: free amounts | Returns the amount of the swap partition currently unused, in bytes. | Lin, HPUX, AIX, Ubu:8.1 |
| size of <swap> | <integer> Plural: sizes | Returns the size, in bytes, of the swap partition. | Lin, HPUX, AIX, Ubu:8.1 |
| total amount of <swap> | <integer> Plural: total amounts | Same as size of <swap>. | Lin, HPUX, AIX, Ubu:8.1 |
| used amount of <swap> | <integer> Plural: used amounts | Returns the amount of the swap partition currently in use, in bytes. | Lin, HPUX, AIX, Ubu:8.1 |
languageCreation Methods| Declaration | Description | Platforms (?) |
| system locale | Determines which bitmap fonts, and OEM, ANSI, and MAC code pages are defaults for the system. This only affects applications that are not fully Unicode. | Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1 |
| system ui language | Determines the default language of menus and dialogs, messages and help files. | Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1 |
| user locale | Determines which settings are used for formatting dates, times, currency, and numbers as a default for each user. Also determines the sort order for sorting text. | Win, WM |
| user ui language | Non-MUI: Same as system UI Language.MUI: Determines the language of menus and dialogs, messages, and help files. | Win, WM |
Properties| Declaration | Return type | Description | Platforms (?) |
| <language> as string | <string> | Returns the language of the system locale. | Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1 |
| platform id of <language> | <string> Plural: platform ids | Returns the string resulting from a call to setlocale(LC_TYPE, ""). This call examines the system environment and returns a string representing the language and character set for any text-related system function. The string is of the form "en_US.UTF-8". | Lin, Sol, HPUX, AIX, Ubu:8.1 |
| primary language of <language> | <primary language> Plural: primary languages | Extracts the primary language identifier from a language. | Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1 |
primary languageCreation Methods| Declaration | Description | Platforms (?) |
| primary language of <language> | Extracts the primary language identifier from a language. | Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <primary language> as string | <string> | Returns the primary language. | Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1 |
computerCreation Methods| Declaration | Description | Platforms (?) |
| computer | Refers to the computer itself. Example: name of computer - Returns the name of the computer, for example "MacBES". | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
| name of <computer> | <string> Plural: names | The name of the computer. | Mac |
registryrootCreation Methods| Declaration | Description | Platforms (?) |
| iokit registry | Returns the root of the registry; the place to start with the registry. | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
| audio plane of <registryroot> | <registrynode> Plural: audio planes | The audio plane of IOKit's registry. | Mac |
| devicetree plane of <registryroot> | <registrynode> Plural: devicetree planes | Returns the device tree plane of IOKit's registry. The device tree contains extensive information about devices in the system. | Mac |
| dictionary of <registryroot> | <dictionary> Plural: dictionaries | Returns a dictionary from the root of the IOKit registry. | Mac |
| firewire plane of <registryroot> | <registrynode> Plural: firewire planes | The firewire plane of IOKit's registry. | Mac |
| node <string> of <registryroot> | <registrynode> Plural: nodes | The named node of the root of the IOKit's registry. | Mac |
| power plane of <registryroot> | <registrynode> Plural: power planes | The power plane of IOKit's registry. | Mac |
| service plane of <registryroot> | <registrynode> Plural: service planes | The service plane of IOKit's registry. | Mac |
| usb plane of <registryroot> | <registrynode> Plural: usb planes | The usb plane of IOKit's registry. | Mac |
registrynodeCreation Methods| Declaration | Description | Platforms (?) |
| audio plane of <registryroot> | The audio plane of IOKit's registry. Example: name of audio plane of iokit registry - Returns the name of the audio portion of the IOKit registry. | Mac |
| devicetree plane of <registryroot> | Returns the device tree plane of IOKit's registry. The device tree contains extensive information about devices in the system. Example: name of devicetree plane of iokit registry - Returns the name of the device tree. | Mac |
| firewire plane of <registryroot> | The firewire plane of IOKit's registry. Example: name of firewire plane of iokit registry - See: man ioreg or the Apple Developer documentation. | Mac |
| node <string> of <registryroot> | The named node of the root of the IOKit's registry. Example: exists (node "IORootParent" of iokit registry) - Returns TRUE if the specified node exists. | Mac |
| power plane of <registryroot> | The power plane of IOKit's registry. Example: name of power plane of iokit registry - See: man ioreg or the Apple Developer documentation. | Mac |
| service plane of <registryroot> | The service plane of IOKit's registry. Example: name of service plane of iokit registry - See: man ioreg or the Apple Developer documentation. | Mac |
| usb plane of <registryroot> | The usb plane of IOKit's registry. Example: name of usb plane of iokit registry - See man ioreg or the Apple Developer documentation. | Mac |
| node <string> of <registrynode> | The named node of the given node of the IOKit registry. Example: exists node "IOPowerConnection" of power plane of iokit registry - Returns TRUE if the specified node exists. Example: names of nodes whose (name of it contains "DMAEngine") of audio plane of iokit registry - Returns a list of nodes with names containing the specified string, such as Apple02DBDMAAudioDMAEngine. | Mac |
| node of <registrynode> | The nodes of the given node of the IOKit registry. Example: names of nodes of power plane of iokit registry - Returns a list of names, such as IOPowerConnection. | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
| classname of <registrynode> | <string> Plural: classnames | The class name of the IOKit registry node. | Mac |
| dictionary of <registrynode> | <dictionary> Plural: dictionaries | Returns a dictionary from a node in the IORegistry. | Mac |
| name of <registrynode> | <string> Plural: names | Name of the given IOKit registry node. | Mac |
| node <string> of <registrynode> | <registrynode> Plural: nodes | The named node of the given node of the IOKit registry. | Mac |
| node of <registrynode> | <registrynode> Plural: nodes | The nodes of the given node of the IOKit registry. | Mac |
| path of <registrynode> | <string> Plural: paths | Path of the node in the IOKit registry. | Mac |
scsibusCreation Methods| Declaration | Description | Platforms (?) |
| scsibus | An iterated property. When used without a number and not iterated it means SCSI bus 0. Example: exists scsidevices whose (vendor of it is "Apple") of scsibuses - Returns TRUE if an Apple SCSI device exists on the SCSI bus. | Mac |
| scsibus <integer> | Returns a SCSI bus with the given number. Example: exists scsidevice whose (vendor of it is "Apple") of scsibus 1 - Here the scsibus is specified and the scsidevice is iterated over vendors. | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
| fast scsi of <scsibus> | <boolean> Plural: fast scsis | Determines if fast SCSI is supported by the SCSI bus. | Mac |
| scsidevice <integer> of <scsibus> | <scsidevice> Plural: scsidevices | Returns a SCSI device with the given number. | Mac |
| scsidevice of <scsibus> | <scsidevice> Plural: scsidevices | Returns a SCSI device associated with the given bus. | Mac |
| version of <scsibus> | <version> Plural: versions | Version of the SCSI bus. | Mac |
| wide16 scsi of <scsibus> | <boolean> Plural: wide16 scsis | Whether wide16 is available for the given SCSI bus. | Mac |
| wide32 scsi of <scsibus> | <boolean> Plural: wide32 scsis | Whether wide32 is available for the given SCSI bus. | Mac |
scsideviceCreation Methods| Declaration | Description | Platforms (?) |
| scsidevice | An iterated property. It is derived from calls to the MacOS. | Mac |
| scsidevice <integer> | Returns a SCSI device with the given number. | Mac |
| scsidevice <integer> of <scsibus> | Returns a SCSI device with the given number. | Mac |
| scsidevice of <scsibus> | Returns a SCSI device associated with the given bus. | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
| product of <scsidevice> | <string> Plural: products | The product string for the given SCSI device. | Mac |
| revision of <scsidevice> | <string> Plural: revisions | The revision of the SCSI device. | Mac |
| type of <scsidevice> | <string> Plural: types | Returns a SCSI device type, such as: DISK, TAPE, PRINTER, CPU, WORM, CDROM, SCAN, DISK, or UNKNOWN. | Mac |
| vendor of <scsidevice> | <string> Plural: vendors | Vendor string for given SCSI device. | Mac |
sound volumeCreation Methods| Declaration | Description | Platforms (?) |
| <sound volume> {op} <integer> | Operates on a sound volume and an integer, returning a sound volume, where:{op} is one of: *, /. | Mac |
| <sound volume> {op} <sound volume> | Operates on two sound volumes, returning another sound volume, where:{op} is one of: +, -. | Mac |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <sound volume> {cmp} <sound volume> | <boolean> | Compares two sound volumes, where: {cmp} is one of: =, <, <=. | Mac |
| <sound volume> {cmp} <stereo volume> | <boolean> | Compares a sound and a stereo volume, where: {cmp} is one of: =, <, <=. | Mac |
| <sound volume> {op} <integer> | <sound volume> | Operates on a sound volume and an integer, returning a sound volume, where:{op} is one of: *, /. | Mac |
| <sound volume> {op} <sound volume> | <sound volume> | Operates on two sound volumes, returning another sound volume, where:{op} is one of: +, -. | Mac |
| <sound volume> {op} <stereo volume> | <stereo volume> | Operates on a sound volume and a stereo volume, returning a stereo volume, where:{op} is one of: +, -. | Mac |
| <stereo volume> {cmp} <sound volume> | <boolean> | Compares a stereo and a sound volume, where: {cmp} is one of: =, <, <=. | Mac |
| <stereo volume> {op} <sound volume> | <stereo volume> | Operates on a stereo volume and a sound volume, returning a stereo volume, where:{op} is one of: +, -. | Mac |
| <stereo volume> {op} <stereo volume> | <stereo volume> | Operates on two stereo volumes, returning another stereo volume, where:{op} is one of: +, -. | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
stereo volumeCreation Methods| Declaration | Description | Platforms (?) |
| <sound volume> {op} <stereo volume> | Operates on a sound volume and a stereo volume, returning a stereo volume, where:{op} is one of: +, -. | Mac |
| <stereo volume> {op} <sound volume> | Operates on a stereo volume and a sound volume, returning a stereo volume, where:{op} is one of: +, -. | Mac |
| <stereo volume> {op} <stereo volume> | Operates on two stereo volumes, returning another stereo volume, where:{op} is one of: +, -. | Mac |
| <stereo volume> {op} <integer> | Operates on a stereo volume and an integer, returning a stereo volume, where:{op} is one of: *, /. | Mac |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <stereo volume> {cmp} <stereo volume> | <boolean> | Compares two stereo volumes, where: {cmp} is one of: =, <, <=. | Mac |
| <stereo volume> {op} <integer> | <stereo volume> | Operates on a stereo volume and an integer, returning a stereo volume, where:{op} is one of: *, /. | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
usbCreation Methods| Declaration | Description | Platforms (?) |
| usb | The Universal Serial Bus. | Mac |
Properties| Declaration | Return type | Description | Platforms (?) |
| isochronous of <usb> | <boolean> Plural: isochronouses | The isochronous attribute of the USB installed. Taken from the Gestalt Manager. | Mac |
| version of <usb> | <version> Plural: versions | The version of the USB installed in the system. Taken from the Gestalt Manager. | Mac |
runlevelCreation Methods| Declaration | Description | Platforms (?) |
| runlevel | Returns the current runlevel of the local machine. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <runlevel> as string | <string> | Casts a runlevel object as a string. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
| effective time of <runlevel> | <time> Plural: effective times | Returns the time at which the runlevel was set to its current value. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
| previous value of <runlevel> | <string> Plural: previous values | Returns the previous value of the runlevel. In the case where the runlevel has not changed since the system booted, this property evaluates to the empty string. | Lin, Ubu:8.1 |
| value of <runlevel> | <string> Plural: values | Returns the current runlevel. It evaluates to a platform-dependent string indicating the current runlevel. For instance, on Linux the value '3' indicates runlevel 3 and 'S' indicates single user mode. | Lin, Sol, HPUX, AIX, Ubu:8.1 |
operating system product typeCreation Methods| Declaration | Description | Platforms (?) |
| nt domain controller product type | Returns an object corresponding to OS product type of nt domain controller. | Win |
| nt server product type | Returns an object corresponding to OS product type of nt server. | Win |
| nt workstation product type | Returns an object corresponding to OS product type of nt workstation. | Win |
| operating system product type <integer> | Returns an object corresponding to the numbered OS product type. | Win, WM |
| product type of <operating system> | Returns the product type of the operating system, which includes Workstations, Domain Controllers and Servers. | Win, WM |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <operating system product type> = <operating system product type> | <boolean> | Compare two operating system product types for equality. | Win, WM |
Properties| Declaration | Return type | Description | Platforms (?) |
event logCreation Methods| Declaration | Description | Platforms (?) |
| application event log | Returns the object corresponding to the application event log, which records certain application events, such as the failure of MS SQL to access a database. Example: description of record (oldest record number of it) of application event log - Returns a description of the oldest record in the application event log. | Win |
| event log <string> | Returns the named event log, which contains historical information that help to track down system and security problems. There are several distinct logs that you can specify, including:Application log: records application eventsSecurity log: recirds global or local policy audit eventsSystem log: records OS events. Example: exists event log "Application" - Returns TRUE if the application log exists. | Win |
| security event log | Returns a security event log, which records global or local group policy events. | Win |
| system event log | Returns a system event log, which records OS or component events, such as the failure of a bootup service. | Win |
Properties| Declaration | Return type | Description | Platforms (?) |
| oldest record number of <event log> | <integer> Plural: oldest record numbers | Returns an integer corresponding to the oldest record number on the Client computer's event log. | Win |
| record <integer> of <event log> | <event log record> Plural: records | Returns the nth record corresponding to the specified event log. | Win |
| record count of <event log> | <integer> Plural: record counts | Returns the record count for the specified event log. | Win |
| record of <event log> | <event log record> Plural: records | Returns the record corresponding to the specified event log, for instance the application or system event log. | Win |
event log recordCreation Methods| Declaration | Description | Platforms (?) |
| record <integer> of <event log> | Returns the nth record corresponding to the specified event log. Example: exists record (oldest record number of it) of application event log - Returns TRUE if there is an oldest record in the application event log. | Win |
| record of <event log> | Returns the record corresponding to the specified event log, for instance the application or system event log. Example: exists records of application event log - Returns TRUE if the application event log contains any records. | Win |
Properties| Declaration | Return type | Description | Platforms (?) |
| category of <event log record> | <integer> Plural: categories | Returns the category of the specified event log, which is sometimes used to further describe the related action. | Win |
| computer of <event log record> | <string> Plural: computers | Returns the name of the computer that has entered a record in the specified log. | Win |
| description of <event log record> | <string> Plural: descriptions | Returns a human-readable description of the specified event log record. | Win |
| event id of <event log record> | <integer> Plural: event ids | Returns an integer corresponding to the ID of the specified record in the Client computer's event log. | Win |
| event type of <event log record> | <event log event type> Plural: event types | Returns the type of the specified event log record, such as error, warning, information, and others. | Win |
| length of <event log record> | <integer> Plural: lengths | Returns the length of the specified record. This is not the same as the length of the description. | Win |
| record number of <event log record> | <integer> Plural: record numbers | Returns the integer value of the record number corresponding to the specified event log record. | Win |
| source of <event log record> | <string> Plural: sources | Returns the source name (from the application, service, or component that logged the event) of the specified event log record. | Win |
| time generated of <event log record> | <time> Plural: times generated | Returns the time that the specified event log record was generated. | Win |
| time written of <event log record> | <time> Plural: times written | Returns the time that the specified event record was written to the log. | Win |
| user sid of <event log record> | <security identifier> Plural: user sids | Returns the user security ID for the specified record in the event log. | Win |
event log event typeCreation Methods| Declaration | Description | Platforms (?) |
| audit failure event log event type | Returns an object corresponding to an audit failure -- an event related to the failed execution of an action. Example: audit failure event log event type= event type of record (oldest record number of it) of application event log - Returns TRUE if the oldest record of the application event log contains an audit failure. | Win |
| audit success event log event type | Returns an object corresponding to an audit success in an event log. | Win |
| error event log event type | Returns an object corresponding to an error in the event log, such as the failure of a service to start. Example: error event log event type= event type of record (oldest record number of it) of application event log - Returns TRUE if the oldest record of the application event log contains an error. | Win |
| event log event type <integer> | Returns an event type object corresponding to the specified number. The enumerated types include:1: error event2: warning event4: information event8: audit success event16: audit failure event. | Win |
| information event log event type | Returns an object corresponding to an information event -- An informational event which is generally related to a successful action. | Win |
| warning event log event type | Returns an object corresponding to a warning in the event log. Warnings can be used to prevent future system problems. | Win |
| event type of <event log record> | Returns the type of the specified event log record, such as error, warning, information, and others. | Win |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <event log event type> = <event log event type> | <boolean> | Compare two event log event types for equality. | Win |
Properties| Declaration | Return type | Description | Platforms (?) |
zoneCreation Methods| Declaration | Description | Platforms (?) |
| zone | Returns the global Solaris zones. | Sol:8.0 |
| zone <integer> | Returns the Nth (as specified by the integer) global Solaris zone. | Sol:8.0 |
| zone <string> | Returns the named global Solaris zone. | Sol:8.0 |
| zone <uuid> | Returns the named global Solaris zone as specified by the UUID. | Sol:8.0 |
| zone of <process> | Returns the Solaris Zone corresponding to the specified process. | Sol:8.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <zone> as string | <string> | Casts a Zone as a string type. | Sol:8.0 |
| autoboot value of <zone> | <boolean> Plural: autoboot values | Returns TRUE if the specified Solaris Zone is set to Autoboot. | Sol:8.0 |
| boot argument <integer> of <zone> | <string> Plural: boot arguments | Returns the Nth boot argument of the specified Solaris zone. | Sol:8.0 |
| boot argument of <zone> | <string> Plural: boot arguments | Returns a list of the boot arguments of the specified Solaris zone. | Sol:8.0 |
| brand of <zone> | <string> Plural: brands | Returns the brand of the selected Solaris Zone as a string, such as 'native', 'cluster' or 'solaris9'. | Sol:8.0 |
| comment of <zone> | <string> Plural: comments | Returns the comments associated with the specified Solaris Zone. | Sol:8.0 |
| configuration state of <zone> | <string> Plural: configuration states | Returns the configuration state of the specified Solaris Zone as a string type. | Sol:8.0 |
| exclusive ip of <zone> | <boolean> Plural: exclusive ips | Returns TRUE if the Exclusive IP flag is set for the specified Solaris Zone. This configuration implies that a given non-global zone will have exclusive access to one of the NICs on your system. | Sol:8.0 |
| execution state of <zone> | <string> Plural: execution states | Returns the Execution State of the specified Solaris Zone as a string, such as 'Active', 'Running', 'Stopped', etcetera. | Sol:8.0 |
| id of <zone> | <integer> Plural: ids | Returns the ID of the specified Solaris Zone as an integer. | Sol:8.0 |
| inherited package directory of <zone> | <string> Plural: inherited package directories | Returns the inherited package directories of the specified Solaris Zone (if any exist) as strings. | Sol:8.0 |
| init process of <zone> | <process> Plural: init processes | Returns the init process of the specified Solaris Zone. An attempt to get the init process of an inactive zone will result in 'Singular expression refers to nonexistent object'. See the Solaris documentation for more information. | Sol:8.0 |
| name of <zone> | <string> Plural: names | Returns the name of the specified Solaris Zone as a string. | Sol:8.0 |
| network interface <string> of <zone> | <zone network interface> Plural: network interfaces | Returns the named network interface of the specified Solaris Zone. | Sol:8.0 |
| network interface of <zone> | <zone network interface> Plural: network interfaces | Returns a list of the network interfaces of the specified Solaris Zone. | Sol:8.0 |
| path of <zone> | <string> Plural: paths | Returns the path of the given Solaris Zone as a string. | Sol:8.0 |
| physical memory cap of <zone> | <integer> Plural: physical memory caps | Returns the physical memory cap of the specified Solaris Zone (if one exists). An attempt to get the physical memory cap of an zone when none exists will result in 'Singular expression refers to nonexistent object'. See the Solaris documentation for more information. | Sol:8.0 |
| scheduling class of <zone> | <string> Plural: scheduling classes | Returns the scheduling class of the specified Solaris Zone, a platform-provided string. See the Solaris documentation for more information. | Sol:8.0 |
| uuid of <zone> | <uuid> Plural: uuids | Returns the UUID of the specified Solaris Zone. | Sol:8.0 |
zone network interfaceCreation Methods| Declaration | Description | Platforms (?) |
| network interface <string> of <zone> | Returns the named network interface of the specified Solaris Zone. | Sol:8.0 |
| network interface of <zone> | Returns a list of the network interfaces of the specified Solaris Zone. | Sol:8.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <zone network interface> as string | <string> | Casts a Zone network interface as a string type. | Sol:8.0 |
| address of <zone network interface> | <string> Plural: addresses | Returns the address of the specified Solaris zone network interface as a string type. | Sol:8.0 |
| name of <zone network interface> | <string> Plural: names | Returns the name of the specified Solaris Zone network interface as a string. | Sol:8.0 |
uuidCreation Methods| Declaration | Description | Platforms (?) |
| uuid <string> | Returns the named UUID (Universally Unique ID). | Sol:8.0 |
| uuid of <zone> | Returns the UUID of the specified Solaris Zone. | Sol:8.0 |
| maximum of <uuid> | Returns the maximum value from a list of <uuid> types. | Sol:8.0 |
| minimum of <uuid> | Returns the minimum value from a list of <uuid> types. | Sol:8.0 |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <uuid> {cmp} <uuid> | <boolean> | Compares a UUID type to a string, where {cmp} is one of: <, <=, =. | Sol:8.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <uuid> as string | <string> | Casts a UUID as a string type. | Sol:8.0 |
| extrema of <uuid> | <( uuid, uuid )> Plural: extremas | Returns the minimum and maximum extreme values of the given list of UUIDs (Universally Unique Identifiers). | Sol:8.0 |
| maximum of <uuid> | <uuid> Plural: maxima | Returns the maximum value from a list of <uuid> types. | Sol:8.0 |
| minimum of <uuid> | <uuid> Plural: minima | Returns the minimum value from a list of <uuid> types. | Sol:8.0 |
| unique value of <uuid> | <uuid with multiplicity> Plural: unique values | Returns the unique values of a given list of <uuid> types, removing duplicates and sorting by value. | Sol:8.0 |
uuid with multiplicityCreation Methods| Declaration | Description | Platforms (?) |
| unique value of <uuid> | Returns the unique values of a given list of <uuid> types, removing duplicates and sorting by value. | Sol:8.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| multiplicity of <uuid with multiplicity> | <integer> Plural: multiplicities | Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <uuid> types. | Sol:8.0 |